Copyright: Copywrite John Joseph 1996
Citation: Copywrite John Joseph 1996


Contents

The following Help Topics are available:

Getting Started

Main Window

Server COMMANDS from clients

New Client Connections

Registering

General Setup Window

Server Up Notice Window

Client Accept List Window

Client/Server Ban List Window

Operator List Window

Remote Server List Window

Srvpage Operation

FAQ - Frequently Asked Questions

For Help on Help, Press F1


Getting Started

Welcome to WIRCSRV. This is a windows based IRC server. With this program users on windows machines can set up complete IRC networks similar to EFnet or Undernet. (although considerably smaller)

To use this program you need a Windows machine. Windows 3.1, 3.1.1, Windows NT, and Win95 have been tested.  You also need a winsock connection to the internet., and an extra megabyte of  memory.

On-going communication with the program is generally accomplished via a client program such as mIRC or Wsirc. Setup operations are handled via setup windows such as the General Setup Window  .

Setting Up the Server:

Client Connections:

First, start WIRCSRV.  If you only want to connect clients to your server, this is all you have to do. The   IP  address of your server is on the Main Window.  Let users who wish to connect to your server know about this address and your port assignment, which is by default 6667.  If you know your local host address, they can connect with that instead.

Server Connections:

If you wish to allow another WIRCSRV server to connect to you, your server is by default setup to allow server connections. Make sure the remote server has an entry with Remote Password and Local Password set to "openaccess" and have them start the connection.

If you wish to have your server connect to other WIRCSRV servers, select Setup then Remote Server Setup  from the menu on the main window. Add a new entry in the list with the data in:

Remote Server Hostname 	- hostname or IP  of server you want to connect to. This field is used to initiate connections to another server.

Remote Server Mask 	- hostname or IP  mask for the server. If the remote server is on a dynamic address, use this to specify the range. See Masks and wildcards .This field is used to validate incomming server connections.

Remote Password  	- corresponds to the field on the other server in Local Password, default "openaccess" should be fine.

Local Password 	- corresponds to the field on the other server in Remote Password, default "openaccess" should be fine.

Remote Port 	- correstponds to the Port value in the Main Window of the other server, default of 6667 should be fine.

Then check the Auto Attempt Connection field. (turn it on)

On the Main Window make sure the Serv Retry field is not zero (10 seconds is the default)

See Foreign Server Connections for details on connecting WIRCSRV to ConferenceRoom or unix ircd.

See Remote Server List Window  for more details on defining the remote server.

See Server Commands from Clients for a list of irc commands (including operator commands).


Operating Server

Most server commands are entered from an irc client with irc operator status.  Refer to Commands List or RFC1459 for more information on entering operator commands. You become an irc operator by entering the /oper command.

There are several setup windows for configuring your server:

General Setup Window  for general configuration

Client Accept List Window  to specify what clients are allowed to connect

Client/Server Ban List Window  to specify what clients to ban from the server

Operator List Window  to specify what clients may become irc operators

Remote Server List Window  to specify server connections


Main Window

The main window in WIRCSRV contains a menu, and several fields, used to monitor and control server operation.

Fields on main window:

Port:	Defines port that server is listening on, this field can be modified.

Host IP:	Displays the server internet protocol address.

Channels:	Displays the number of channels formed.

Connections: 	Displays the total number of connections created, server and client.

Servers:	Displays the number of servers connected.

Local Users:	Displays the number of clients connected locally, i. e. not through a remote server.

Summon Enable:	Allows bell to ring when a user issues the SUMMON command.

Serv Retry:	Seconds between server connection attempts, or zero to disable.

Connections:	Show current connection information for clients and servers

Status Log:	Show status log display.

Restart:	Cancel all connections and initialize winsock access.

Clear:	Clear status log window.

Displayed when Connections button is selected:

Status:	Show status of current connection

Time Up:	Show time connection was started

Nick:	Show nickname for connection if client

Host:	Show hostname for connection

IP:	Show IP  address for connection

Hops:	Show number of hops to other end of connection

Server:	Show server name for connection

In:	Show number of messages received from connection

Out:	Show number of messages sent to connection

ListBox	Show nick or servername for all connections

Main Menu:

File, Exit	Halts server

Setup, General Setup 	Displays General Setup Window

Setup, Server Up Notice 	Displays Server Up Notice Window

Setup, Client Accept List	Displays Client Accept List Window

Setup, Client/Server Ban List	Displays Client/Server Ban List Window

Setup, Operator List	Displays Operator List Window

Setup, Remote Server Setup	Displays Remote Server List Window

Setup, Minimize on Startup	Toggles whether WIRCSRV reduces to an icon when started.

Help, Contents	Launches help

Help, Registering	Displays registration information in help

Help, About Wircsrv	Displays program version information.


Server Commands from Clients

Some commands for querying or operating your server are entered via a client program like mIRC. Here is a brief listing of commands. For more information see the specification RFC1459. Note that the beginning slash is not what is sent to the server, but often a requirement of client programs. Commands in bold are operator commands for irc operators. The /oper command  takes parameters that are set in the Operator List Window   .

/admin 	- display server admin info

/away message	- set an away message

/connect servername	- initiate connection to a defined server

/expban 	- propagate client bans to all connected servers

/help 	- displays a listing of commands and parameters

/info 	- display server implementation info

/invite nick #channel	- invite a user to a channel

/ison nick nick nick	- sends nicks of users if on network

/join #channel	- join a new channel

/kick #channel user comment	- kick a user off a channel

/kill nick reason	- boot a user off your network, by nickname

/killban hostmask reason	- ban and boot a user by nickname or address

/links 	- display server links

/list 	- lists channels defined, also try /list #xx*

/lusers 	- display summery information about connections

/mode #channel +x obj	- sets channel mode

/mode nick +x	- sets user mode

/mode +b ban	- add user to ban list

/names #channel	- lists nicknames on a channel

/nick nickname	- change your nickname

/oper uid password	- become ircop

/part #channel	- leave a channel

/privmsg  #channel msg	- send message to all on a channel, also known as /msg

/privmsg nickname msg	- send message to particular nickname

/privmsg $servername msg	- broadcast message to entire server

/quit comment	- leave the network

/stats x	- display server statistics, k,l,m,u

/squit servername cmnt	- break connection with remote server

/summon servername	- ring bell at server computer

/time 	- display time setting of server

/topic #channel newtopic	- sets channel topic if you have authority

/users servername	- display info on all clients of server

/version 	- display version name and number of server

/wallops message	- send message to all other operators

/wall message	- send message to all local users

/who 	- displays brief info on one or more client

/who nickmask o	- displays info on operators online

/whois 	- displays more info on one or more client


Registering

WIRCSRV Licensing, Registration and Distribution

WIRCSRV, copyright 1996 by John Joseph, is a SHAREWARE product. This help topic contains legal binding information about licensing, registration and distribution of WIRCSRV. If you do not agree with the conditions and rules stated in this text, please remove your copy of the WIRCSRV software.

Terms used in this help topic:

The term "SHAREWARE version"  identifies the complete package containing the Microsoft Windows 3.1, Intel i386 version of WIRCSRV. By complete package we mean:

WIRCSRV's executable file and associated help file. The term "SHAREWARE copy" identifies an instance of the SHAREWARE version.

The term "REGISTERED version" identifies the program and associated license sent as a result of purchasing a license for the product. The term "REGISTERED copy" identifies an instance of the REGISTERED version.

No component part of WIRCSRV may be distributed individually, disassembled, copied, reverse engineered, or altered in any form. This includes all elements in the WIRCSRV package, interface items, menus and dialogs, in both REGISTERED and SHAREWARE versions of the software.

Disclaimer:

The author disclaims any implied warranties of merchantability or fitness for any particilar purpose.

WIRCSRV Distribution

1. SHAREWARE copies may be freely distributed by individual users for trial and leisure utilization.

2. SHAREWARE copies may be uploaded to Bulletin Board Systems, FTP sites, Usenet newsgroups and any network sites providing its users with access to download it for trial and leisure purposes. Bulletin Board Systems should restrict downloading charges for the SHAREWARE version to flat rate connection fees.

3. SHAREWARE copies may NOT be distributed in CD-ROM disks, diskettes or any other media, without express authorization of the author. Authorization for distribution may be obtained in the form of a specific "Non-exclusive Distribution License Agreement", signed by the author of the software.

4. SHAREWARE copies may NOT be distributed with any software package, or be systematically  recommended to users of any software system or service, without express authorization of the author. Autorization for distribution may be obtained in the form of a specific "Non-exclusive Distribution License Agreement", signed by the author of the software.

5. REGISTERED versions may only be distributed by the author of WIRCSRV, or by distributors who have obtained a specific "Non-exclusive Distribution License Agreement", signed by the author of the software.

WIRCSRV Non-exclusive Distribution License Agreement

A Non-exclusive Distribution License Agreement must be signed by author of WIRCSRV BEFORE:

1. Including WIRCSRV in a software product package,

2. Distributing or explicit recommending WIRCSRV usage to clients and/or users of a software package or service.

3. Including WIRCSRV in CD-ROMs, diskettes, or any other media.

4. Distributing WIRCSRV in any form other than the ones mentioned in the WIRCSRV Distribution section above.

There is no standard Non-exclusive Distribution License Agreement form. Specific rules are to be defined case by case between the author of WIRCSRV and interested parties. Agreements may, at discretion of the author, include customization of program interface and/or execution,  maintenance and/or upgrade clauses.

WIRCSRV Registration

1. Individual or home users may  utilize SHAREWARE copies for LEISURE purposes. In this case,  registration is NOT required.

2. Individual or home users may NOT utilize SHAREWARE copies for work related tasks. In this case, registration is required after a 20 day trial period. To obtain a REGISTERED copy, individual or home users must fill out the "Individual User Registration Form" included in the SHAREWARE version package,  and mail it to the author of WIRCSRV, together with the registration fee.

3. SHAREWARE copies may NOT be utilized at office computers or employee home computers for work related tasks. In both cases registration is required. REGISTERED copies must be obtained either through individual user registration.

Registering WIRCSRV

To register send $30 US, by check or money order to:

WIRCSRV P.O. Box 1013, Mechanicsburg Pa., 17055

-  (remember to add appropriate sales tax if mailed from Pennsylvania)

Make Checks payable to WIRCSRV

To receive a license you must include the information on the Registration Form .

Checks or money orders must be drawn on a U.S. bank

Allow 1 week from date of receipt for your program and license to be emailed to you if you pay by Money order, or Certified check.

If you pay by personal check, allow 2 weeks for your program and license to be emailed to you (This is to allow your check to clear at the bank, and a little time to process orders) Yes, I know, you want it NOW, but please be patient, even in the electronic age, some banks seem to operate in the horse and buggy days.


Server Info String

This entry specifies the server description. This description shows up in responses to commands like INFO.

Roughly corresponds to M config line.


Operator UID

The OPER command is used to allow a normal user to become an IRCop. The OPER command takes 2 parameters, this specifies the first. It can be any value you like and has no relation to nickname or any other parameter.  Keep in mind that an operator on any WIRCSRV server is an operator on all. Be careful who you allow to be ops.


Operator Password

The OPER command is used to allow a normal user to become an IRCop. The OPER command takes 2 parameters, this specifies the second. It can be any value you like. Keep in mind that an operator on any WIRCSRV server is an operator on all. Be careful who you allow to be ops.


Message Of The Day

This section defines a message that will be sent to all new client connections. It can be up to 100 lines long. Consider the MOTD like a greeting that you will send all people connecting to your server.


New Client Connections

Whenever a new client connects to your sever, they go through a validation process. This is so that you can know who it is that is connecting to you and allow you to prevent certain users from signing on. Wircsrv does not user identd verification. The connection sequence is:

Client initiates a connection with the server

Client sends NICK message

Client sends USER message

Server does a  lookup of the connected Internet Address (IP ).

If the lookup fails (Some Chameleon winsocks have a problem here)

Server does a DNS  lookup of the hostname specified in the USER message.

If all lookups fail, user cannot be verified, and the IP address is used as a hostname.

Logon complete


DNS

DNS stands for Domain Name Server. This is a server that resolves internet addresses into hostnames or vice versa.


FAQ - Frequently Asked Questions

FAQ

Q. How much does the registered version cost?

A. The version is $30 U.S. See "Registering" in the program help file for details.

Q. Is my server connected to EFnet?

A. Considering the volume of users and traffic on EFnet, a PC (and most PC connections) would not be able to handle the load. Keep in mind that eventually you would be able to set up your own PC-net. Maybe not as big as the major nets, but controlled by YOU.

Q. How do I connect the server to Efnet?

A. Wircsrv can connect to an ircd server, but it WILL NOT connect to Efnet, or Dalnet, or Undernet.

Q. How do I let people know about my server when I have a dynamic hostname?

A. Use the "Server Up Notice" menu option and have your server generate a web page entry on a world wide web page.

Q. What do I need to run WIRCSRV?

A. Windows 3.1, or Windows95, or Windows/NT

 1 meg of free memory

 Winsock 1.1 or better

 A true PPP internet connection

 A Domain Name Server (DNS) running locally, or at your ISP.

Q. How do people connect to my server?

A. Generally, you would connect to your server as you would connect to any IRC Server. The common command to initiate an irc connection is /server server.name.com  -- In this case the server name is the host name of your PC. In the case that your PC doesn't have a resolvable hostname, you can use your IP address as the server name.

Q. How do I find out my current hostname or IP?

A. The easiest way to find out your current host address is to connect to a remote server via an irc client and do a /whois on yourself. The remote server has to resolve your host name during connection with you. When you try to resolve your own hostname, you may get an invalid result especially if you have a dynamic host address.

Q. How do I control my server?

A. There are a few controls on the main window if WIRCSRV, and there is a setup window. But ongoing server control is done via a client program, like mirc, or wsirc. You would connect to your server, enter the /oper command, and then you can do server commands that you wished you could do on EF-net, like /kill nickname bye!

Q. How do I become and ircop (server operator) on my server?

A. Define an entry in the Operator List setup window for the user. Then use the /oper command with the two parameters from your setup window "Operator UID" and "Operator Password".

Q. Where is everybody on the channels I enter?

A. Again, your server is NOT connected to EFnet. You can talk to people that connect to your server or people connected to other servers that you connect to. You are not part of an existing irc network...(unless you make your own with a few friends and WIRCSRV).

Q. How many users can I connect?

A. With an unregistered version you can connect 10 users, one of which can be a server connection to another copy of WIRCSRV.  With a licensed copy you can accomodate up to 3000 logical connections, and up to 50 max local connections. This limitiation is because of the instability of winsock at or above that number of connections.

Q. How do I get around a firewall on my system?

A. The short answer is: You don't. You can only use your server with people that can directly connect with your system.

Q. How much of WIRCSRV is ported from the unix program ircd?

A. None. The author has intentionally never seen ircd code.

Q. Where is the REHASH command?

A. You might think it is an essential command. But a pc based network is a different environment. REHASH is not needed because all changes take effect immediately. If you change something in setup, it takes effect as soon as you leave setup.


nick

Syntax: /nick <nickname>

This command sets your unique nickname for your session with the irc network.

<nickname> can be between 1 and 9 characters of A-Z, a-z, 0-9, or  _ - [ ] \ ` ^ { }|

Example: /nick foo


oper

Syntax: /oper <uid> <password>

This command gives a user ircop priviledges. There is no limit on how may users can be ops. Any user with an entry in the Operator List that supplies the correct <uid> and <password> becomes an irc operator on the network. All irc operators are global, meaning that any operator can kill any nickname on any server.

See Operator List Window  for how to set  <uid> and <password>. Only let trusted people have access to ircop status.

Example: /oper mumble fubar


quit

Syntax: /quit [<comment>]

This command disconnects you from the server leaving an optional comment for those that share a channel.

Example: /quit bye


squit

Syntax: /squit <servername> <comment>

This command disconnects one server from another. Use this command after removing a server from the Server List. In this way the server connection is broken and the server cannot reconnect.

If the server is on the Server List with the Auto Connect switch on, this command turns off the switch.

This command is the functional inverse of connect.

Example: /squit ix.host.com bye


join

Syntax: /join <channel> [<key>]

This command initiates the connection with a channel, if the channel is set such that the user has the authority to join. The <key> values is used when a channel is password protected.

Example: /join #chan


part

Syntax: /part <channel>

This command disconnects a user from a channel.

Example: /part #chan


mode

Syntax: /mode <channel>

Displays the existing channel modes.

Syntax: /mode <channel> <opt>  [<param>]

Sets channel modes (channel ops and ircops only).

<opt> can be:

+o <nick>	- make nick an operator on channel

+p 	- make channel private

(invisible to /names command and hide topic from /list)

+s	- make channel secret (invisible to /names and /list commands)

+i	- make channel invite only

+t	- make topic settable only by operators

+n	- prevent those outside channel from sending channel messages

+m	- make channel moderated so only ops and thos with +v can talk

+l <num>	- limit channel to a certain number of members

+b <ban>	- ban user(s) from channel

+v <nick>	- allow nick to talk on moderated channel

+k <key>	- specify password that those entering the channel must supply

Note that  a - instead of a + turns the option off.

Syntax: /mode <nickname>

Displays your user mode settings.

<nickname> must be your own nick.

Syntax: /mode <nickname> <opt>

Sets your user mode settings.

<opt> can be:

+i	- make user invisible to /whois, /who, and /users

+w	- receive wallops (ircop only)

+s	- receive server notices (ircop only)

+n	- receive nickchange notices (ircop only)

Note that a - instead of a + turns the option off.

Note also that for efficiency reasons +s is not implemented on this server.

Syntax: /mode <+b | -b> <ban>

Adds or removes a server ban (ircops only)

<ban> see Client/Server Ban List Window  for info on ban syntax.

Syntax: /mode <+b | -b>

Lists all bans in effect. (ircops only)


topic

Syntax: /topic <channel> <topic>

This command sets the channel topic. If the channel has mode +t set, you must be a channel op to use it.

Example: /topic #chan New topic

Syntax: /topic <channel>

This command lists the current channel topic.

Example: /topic #chan


names

Syntax: /names <channel>

This command lists the nicknames on the specified channel unless the channel is marked +s or +p.

Syntax: /names

This command lists all the nicknames in all formed channels unless they are marked +s or +p.


list

Syntax: /list <channelpat>

This command lists formed channels, the number of members, and topic.

<channelpat> can be a channel name or wildcard like #help*

Syntax: /list

This command lists all formed channels unless they are marked +s. If they are +p the topic is not shown.


invite

Syntax: /invite <nickname> <channel>

This command invites a user to a channel. If the channel exists, you must be an operator to use it.


kick

Syntax: /kick <channel> <nickname> [<comment>]

This command kicks a user off a channel. (channel ops only).


version

Syntax: /version

This command displays server version information.


stats

Syntax: /stats <opt>

This command displays server statistics.

<opt> can be:

k	- list bans

l	- list server links

m	- list valid messages

u	- shows server uptime


links

Syntax: /links [<mask>]

This command shows all client and server links for the local server. If mask is entered, it is used to filter the links to display. See Masks and wildcards

Syntax: /links <mask>

This command shows all client and server links that match the <mask>

Syntax: /links <remote server> [<mask>]

This command shows all client and server links for a remote server.  If mask is entered, it is used to filter the links to display.


lusers

Syntax: /lusers

This command displays a summery of connection information.


time

Syntax: /time

This command displays the current date and time setting on  the server machine.


info

Syntax: /info

This command displays implementation information for the server. This is where deviations from the RFC1459 are listed.


who

Syntax: /who

This command displays a listing of all visible users on the irc network containing this server.

Syntax: /who <channel>

This command displays user information on all users in <channel>.

Syntax: /who <mask>

This command displays user information on all users that match the <mask> for nickname, username, or hostname. See Masks and wildcards  .

Syntax: /who [ <mask> [<o>] ]

This command displays user information on all operators that match the <mask> for nickname, username, or hostname.


whois

Syntax: /whois <nickmask>

This command displays detailed user information on all users that match <nickmask>. Wildcards * and ? are allowed. See Masks and wildcards

Syntax: /whois <servername> <nickmask>

This command displays detailed user information on all users on <servername> that match <nickmask>. Wildcards * and ? are allowed.


kill

Syntax: /kill <nickmask> <comment>

This command kicks user(s) off the server. It must be used with care because it is more powerful than the standard /kill command you can /kill * which would kill all nicks, except you. It was designed this way to allow uses like killing all nicks that include a profane word. Wildcards * and ? are allowed. See Masks and wildcards


away

Syntax: /away

This command removes an away message for the current user.

Syntax: /away <comment>

This command sets the away message, so that when a message is recieved by the user, this message is sent in return.


summon

Syntax: /summon

Summon the user at server machine by ringing bell. The bell can be turned off so that this command is deactivated, see Main Window .


users

Syntax: /users [<servername>]

This command displays user information for all users on the local server, or on the server specified by <servername>.


wallops

Syntax: /wallops <message>

This command sends a message to all irc operators on the network. It is for Operators only.


ison

Syntax: /ison <nickname> <nickname> . . .

This command echoes a nickname if the nick is online. Mirc uses this command to determine if anyone on your notify list is signed on.


Masks and wildcards

Masks are names that contain the asterisk (*) and question mark (?) characters as wildcards. The asterisk is used to represent any number of unknown characters. The question mark is used to represent a specific number of unknown characters.

Examples:

mas*	- matches master, or mass, but NOT mis

mas?	- matches mass, but NOT master

*mas	- matches xmas, or christmas

?mas	- matches xmas, but NOT christmas


help

This command displays a list of commands and parameters.


General Setup Window

The General Setup Window includes serveral fields that are used to control the operaton of the server:

Server Info String  - Displayed on MOTD and INFO responses

Server Name - Unique server name in your irc network

Server Full Msg  - Message do be displayed when Max Active Users is reached.

Allow Remote Bans  - On if remote ban exports will be honored

Ping Timeout  - Time to wait before sending PING

Max Output Flood - Max msgs in the output queue

Max Input Flood- Max msgs in input queue

Max Active Users - Max number of connections to allow

Admin Name - Your name

Admin Address - Your address

Admin Email - Your email address

Message Of The Day  - Data to be sent to new client connections

When you have made the changes you like press the OK button.

To abort changes press the CANCEL button.


Server Name

This entry specifies the name that the server will be known by on the network. Note that this is not necessarily the hostname of the server, although this is the default. Note that clients must use the server hostname (or IP  address) to connect to a server. The server name only specifies how you wish to refer to a server on your irc network. Server names must be unique on all connected servers.


Server Full Msg

This entry specifies the message to be sent when no more client connections are available. (Max Active Users reached)


Allow Remote Bans

This entry specifies whether to allow other servers to add to the client ban list, via the /expban command. If this box is checked, and an ircop on a connected server enters the /expban command, any ban on that server that doesn't already exist locally, will be added. If this box is not checked (off) then remote bans will be ignored, but passed through to other connected servers. Note that ircd and CR do not recognise or pass through /expban.


Ping Timeout

This entry specifies how long to wait idle before issueing a PING command. If no response is received after 3 times this value, the connection is droped. This goes for servers and clients alike.

Roughly corresponds to Y config data.


Max Output Flood

This entry specifies the maximum number of messages to accumulate in the output buffer before assuming that the user is trying to flood the server output queue. When this number of messages is reached in the output queue, the connection to the client is dropped.


Max Input Flood

This entry specifies the maximum number of messages to accumulate in the input buffer before assuming that the user is trying to flood the server. When this number of messages is reached in the input queue, the connection with the client is dropped.


Max Active Users

This entry specifies how many local connections to allow. This includes clients and servers. Winsock tends to behave unpredictably when large numbers of connections are attempted in a program. This parameter allows you to specify the maximum number of connections that you will allow. You can set this value as high as you like, but keep in mind that Winsock becomes unstable after about 50 connections.

(Note that in the unregistered version this value is cannot be changed.)


Admin Name

This entry specifies the name to display in the response to the /admin command.


Admin Address

These fields specify the address to return for the /admin  command.


Admin Email

This field specifies the email address to return for the /admin  comand.


admin

Syntax: /admin

This command displays admin information specified in the General Setup Window .


Client Accept List Window

This window is used to enter configuration information to determine what clients may connect to your server. The window consists of a list box with all the entries, and a set of fields that allow you to update each entry. You can have as many of these entries as you like, but remember that a lot of fields will tend to degrade server speed. You must have at least one entry in this list. The fields are:

IP Mask:	- Specifies what IP  values will be allowed. An asterisk here allows all, or 132.23.2.* allows all IP's that begin with 132.23.2, so that the last number can be anything. See Masks and wildcards

Password:	- Specifies a password that must be entered by the user or client program in order to connect with this entry. With this you can restrict access to those who know the password.

Domain Mask:	- Specifies what domain name values will be allowed. An asterisk here allows all, or ix.necex.* allows all hostnames that begin with ix.necex. See Masks and wildcards

Disable:	- This field allows you to leave the entry but temporarily disable it's function.

Comment:	- This field is strictly a comment to aid in remembering what each entry is for.

To add an entry press the INSERT button.

To remove an entry press the DELETE button.

To duplicate the current entry press the COPY button.

When you have made the changes you like press the OK button.

To abort changes press the CANCEL button.


Client/Server Ban List Window

This window is used to enter configuration information to determine what clients or servers may NOT connect to your server. The window consists of a list box with all the entries, and a set of fields that allow you to update each entry. You can have as many of these entries as you like, but remember that a lot of fields will tend to degrade server speed. The fields are:

Host Mask:	- Specifies what IP  values or hostnames will not be allowed. An asterisk here bans all, or 132.23.2.* bans all IP's that begin with 132.23.2, a hostname of ix.necex.* bans all hostnames that begin with ix.necex. When entered from the /mode command, this is the field that corresponds to <ban>.

Disable:	- This field allows you to leave the entry but temporarily disable it's function.

Comment:	- This field is a comment to aid in remembering what each entry is for.

To add an entry press the INSERT button.

To remove an entry press the DELETE button.

To duplicate the current entry press the COPY button.

When you have made the changes you like press the OK button.

To abort changes press the CANCEL button.


Operator List Window

This window is used to enter configuration information to determine what clients may become server operators (ircop). The window consists of a list box with all the entries, and a set of fields that allow you to update each entry. You can have as many of these entries as you like, but remember that a lot of fields will tend to degrade server speed. The fields are:

Host Mask:	- Specifies what IP  values or hostnames will be allowed to become ircops. An asterisk here allows all, or 132.23.2.* allows all IP's that begin with 132.23.2, a hostname of ix.necex.* allows all hostnames that begin with ix.necex.

Operator UID:	- Specifies the first of two entries to be entered on the /oper command.

Operator Password:	- Specifies the second of two entries to be entered on the /oper command.

Disable:	- This field allows you to leave the entry but temporarily disable it's function.

Comment:	- This field is a comment to aid in remembering what each entry is for.

To add an entry press the INSERT button.

To remove an entry press the DELETE button.

To duplicate the current entry press the COPY button.

When you have made the changes you like press the OK button.

To abort changes press the CANCEL button.


Remote Server List Window

Information on this window is used to control server connections to and from your server. The window consists of a list box with all the entries, and a set of fields that allow you to update each entry. You can have as many of these entries as you like, but remember that a lot of fields will tend to degrade server speed. The fields are:

Remote Server Hostname	- Specifies what IP  values or hostnames will be used when attempting to initiate connection with the server. If the Auto Attempt Connection box is checked, this field must indicate a valid hostname or ip.

Remote Server Mask:	- Specifies a hostmask or IP mask for servers that are allowed to attempt connection with your server. Use this to specify a single address, or a range of addresses for a dynamic IP. This field can be an asterisk *, but if you have more than one mask with an asterisk defined, the first found will be used for validation.

Remote Server Name:	- Specifies the expected server name of a remote server. (Optional)

Remote Password	- Specifies the password to send to a remote server on connection.

Local Passowrd	- Specifies the password to expect from a remote server that matches this server hostmask.

Remote Port	- Specifies the port on which to attempt connection.

Auto Attempt Connecton	- Specifies whether to attempt connection to Remote Server Hostname.

Disable:	- This field allows you to leave the entry but temporarily disable it's function.

Comment:	- This field is a comment to aid in remembering what each entry is for.

To add an entry press the INSERT button.

To remove an entry press the DELETE button.

To duplicate the current entry press the COPY button.

When you have made the changes you like press the OK button.

To abort changes press the CANCEL button.


privmsg

Syntax: /privmsg <channel> <msg>

This command sends a message to an entire channel. The message is sent by the

server to every other user on the channel.

Syntax: /privmsg <nickname> <msg>

This command sends a message to a particular user via the server. When the server

gets such a message, it is redirected to the nickname specified.

Syntax: /privmsg $<servermask> <msg>

This command broadcasts a message to all others on the server(s) specified. This is

an ircop only command. If you use $* as servermask, the message is sent to all clients on all connected servers.

NOTE: On some client programs, the privmsg command can be entered as /msg or simple text in a channel window.


IP (Internet Protocol)

An IP address is a dotted decimal address like 123.321.21.3

A segmented number like this defines a location (machine) on the internet. If you are on the net, your machine has such a number.

You may also have seen machines being contacted using a name instead of such a number, this is called a Host Name. But even when this is used, it must be converted to an IP address (via DNS) before a connection can be made.

If you have a Dynamic IP address, it means that your ip address changes every time you signon. Your Internet Service Provider may do this so that they can sell more connections than the number of IP addresses they have been allocated.

If you have a Dynamic IP address and want to let people know the current address, you can either connect with someone that has a static address, or advertise your current IP/Host address on a channel of an existing IRC Network.


Registration Form

Name __________________________________________________________________________

Email address __________________________________________________________________

Mailing address _________________________________________________________________

yes/no --- you would like your email address to be added to a server connection registry that may be established in the future.

(optional) How did you hear about WIRCSRV? ___________________________________________

________________________________________________________________________________


wall

Syntax: /wall <message>

This command sends a message to all local users on your server. It is for Operators only.

Syntax: /wall  $<servermask> <message>

This command sends a message to all local users on a connected server, or set of servers. It is for Operators only.


killban

Syntax: /killban <hostmask> <comment>

This command first bans then kicks user(s) off the server. It must be used with care because it is a very powerful command. /killban * would kill and ban all users, and ban you too. Wildcards * and ? are allowed. See Masks and wildcards

Example: /killban *.naughty.com Thats enough

Example: /killban 123.321.34.* Go away

Syntax: /killban <nickname> <comment>

This command allows you to use a nickname to ban and kick a user off the server. What shows up in the ban list is the hostname of the user.

Example: /killban badseed So long


expban

Syntax: /expban

This command causes the client ban list to be sent immediately to all connected servers. If a connected server has the Allow Remote Bans option set, the bans will be added to the server's list.. Use this command to propagate bans so that a banned user cannot gain access to any connected server.

Note that this command is not recognised or passed through by ircd or CR.


Foreign Server Connections

If you wish to have your server connect to IRCD or ConferenceRoom servers, the steps are the same as in Getting Started  Server Connections.

If the remote server is ConferenceRoom version 1.1, make sure it is set in ircd mode, and NOT CR mode.

If the remote server is ircd, make sure it is version 2.7 to 2.8.21


connect

Syntax: /connect <servername>

This command initiates connection to another server. Use this command after adding a server to the Remote Server List. This command is equivalent to turning on the Autoconnect switch of the server connection definition. For the connection to occur,  an entry for the server must be in the Server List,  and it must not be Disabled. Also, the Serv Retry field must not be zero.

This command is the functional reverse of squit.

Example: /connect ix.host.com


Server Up Notice Window

This window is used to enter the information needed for your server to send an initialization message to a registry program.

The registered version of WIRCSRV comes with a program that will update a web page based on information sent by servers as they initialize. Once you specify this information, the notice is sent each time you start your server. If several servers point this message to the same Server Up Notice program, the effect will be a server selection web page.  The fields are:

My Descrip:	- Specifies a description for your server to show up on the updated web page. This description can be 50 characters or less and can contain no html tags.

Host Address:	- Specifies the  IP  value or hostname of the machine where the Server Up Notice program resides.

Password:	- Specifies the password defined at the Server Up Notice program, the default is "openaccess".

Port:	- Specifies the Port value on which the Server Up Notice program is listening, the default is 6600.


HTML

Hyper - Text - Markup - Language. This is a language designed for defining web pages on the World Wide Web.


Srvpage

SRVPAGE is a program that updates a web page with information sent by wircsrv servers. Here is how it works:

With wircsrv version 4.12 a feature was added to help wircsrv users advertise the existance of their server.. There is a menu item "Server Up Notice". If you access it, you can select a host to be sent a message every time your server is started.

You specify the host address, port number, and password. You can also specify a short description of your server (50 chars or less).

The message generated by your server is read by a program called SRVPAGE. SRVPAGE is distributed with the registered version of WIRCSRV. SRVPAGE is designed to run on a windows based computer with a static internet connection, and web server software. When SRVPAGE receives the message from a wircsrv server, it updates a web page with the address, port and description of the server.

SRVPAGE takes an input template html file, finds the line with @SERVERDATA and replaces that line with the current list of server information. It then produces an updated web page suitable for displaying on the web.

You can now tell people to review a web page to find out your current address, and you can join a group of servers on the same web page.

The main screen of SRVPAGE consists of a list box and several types of fields:

General Fields refer to SRVPAGE in general.

Server Connection Entries refer to data repeated for each entry in the validation list.

Last Connection Fields refer to data obtained from a previous message from a server. These can be associated with Server Connection Entries. When they are, the entry will end up as a line in the target web page.

SRVPAGE General Fields:

HTML Template:	- This is the file with the original HTML template file. The default is template.htm. But you can create your own file and include whatever text and/or graphics you like. Where ever you want the server information to show up, you put the line @SERVERDATA .

HTML Target:	- This is the file that will contain the updated web page. Define this field so the target file is in a directory that is accessible to your web server software.

Listen Port:	- This is the port to listen for Wircsrv messages. The default is 6600.

IgnoreAfter	- This fields lets you define how old an entry can be before it will not show up in the target page. If you specify one day, then any entry older than a day will not show up in the list.

SRVPAGE Server Connection Entries: fields pertain to an entry in the list box.

ServerName	- This field defines a name for the server entry. It will be updated by a server when a message is received.

ServerPort	- This field is informational only. It will be filled with the port address that a server uses for connections.

HostMask:	- This field allows you to define which servers are authorized to send messages to be posted in your SRVPAGE. This is a Hostmask field. If this field is an asterisk *, every server that uses a valid password will spawn another entry specific for that server.

Password:	- Allowable password for this entry. The default is "openaccess". This is also the default password on the Wircsrv Server Up Notice Window . This field allows you to assiciate a password with a specific Hostmask. If the Hostmask is an asterisk, the password applys to all messages from servers.

Comment:	- Internal comment for this entry. This will not show up on the web page. It's purpose is to allow you to attach a note to a specific entry.

SRVPAGE Last Connection Fields:  filled in by server messages

Last Hostname:	- Host name last used by this entry.

Last IP: 	- Host IP address last used by this entry.

Last Uptime:	- Last time this entry was used.

Last Descript:	- Description last sent by wircsrv server for this entry.